[skip changelog] Fully document library layouts in specification #1458
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Arduino library authors may chose from multiple structures, each of which have different implications for the compilation of the library source files. The specification explains this in a somewhat simplistic manner as "1.5 format" and "1.0 format". That is sufficient for most, but does not provide a complete picture. Feedback indicated that more advanced users were left wanting complete documentation, which is provided here. The subject is not well suited for description via prose, so a chart and table are employed instead. The chart is defined in the DOT graph description language.
per1234
added
type: enhancement
silvanocerza
approved these changes
Sep 20, 2021
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Please check if the PR fulfills these requirements
before creating one)
our contributing guidelines
UPGRADING.mdhas been updated with a migration guide (for breaking changes)Docs update
Arduino library authors may chose from multiple structures, each of which have different implications for the compilation
of the library source files. The specification explains this in a somewhat simplistic manner as "1.5 format" and
"1.0 format". That is sufficient for most, but does not provide a complete picture. Feedback indicated that more advanced
users were left wanting complete documentation
More comprehensive documentation of the subject is provided.
The subject is not well suited for description via prose, so a chart and table are employed instead.
The chart is defined in the DOT graph description language, which is also used in the Pluggable Discovery Specification
titled accordingly?
No breaking change.
Resolves #1013
Reference: https://github.com/arduino/arduino-cli/blob/master/arduino/libraries/loader.go